/**
 * @(#)${NAME}.java Jul 22, 2006
 *
 * Copyright (c) 2005-2010 Psiqueware S.A. de C.V. All Rights Reserved.
 * This software is the proprietary information Psiqueware S.A. de C.V.
 * Use is subject to license terms.
 *
 * THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS "AS IS" AND ANY EXPRESS OR
 * IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND
 * FITNESS FOR A PARTICULAR PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT OWNER OR
 * CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL
 * DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE,
 * DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER
 * IN CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT
 * OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
 *
 *
 * <br/>Usuario : AngelElectrico
 * <br/>Creaci&oacute;n: Jul 22, 2006 - 12:19:12 PM
 * <br/>
 * <br/>
 * <br/><t5>Cambios :</t5>
 * <br/><b>Fecha | Autor  |  Cambios</b>
 * <br/>Jul 22, 2006 | <a href = "mailto:AngelElectrico@PsiqueWare.com">Angel El&eacute;ctrico</a> | Creaci&oacute;n del Objeto.
 */

package com.psiqueware.alheli.id.dao;

import com.psiqueware.alheli.dao.AlreadyPersistedObjectException;
import com.psiqueware.alheli.dao.BaseDAO;
import com.psiqueware.alheli.dao.DAOException;
import com.psiqueware.alheli.dao.EnlaceTransaccional;
import com.psiqueware.alheli.dao.NotAPersistedObjectException;
import com.psiqueware.alheli.id.Dominio;
import com.psiqueware.alheli.id.Usuario;

import java.util.List;

/**
 * Contrato de operaciones CRUD para el objeto Usuario
 * <br/>Paquete Original: com.psiqueware.basico.id.dao
 * <br/>Nombre  Original: UsuarioDAO
 * <br/><a href="UsuarioDAO.java.html"><i>Ver C&oacute;digo Fuente</i> </a>
 *
 * @author <a href="mailto:AngelElectrico@PsiqueWare.com">Angel El&eacute;ctrico</a>
 * @version Revision: 1.1 Jul 22, 2006 12:19:12 PM
 */
public interface UsuarioDAO extends BaseDAO
{

    /**
     * Guarda un {@link Usuario} en persistencia.
     * Este {@link Usuario} no exist&iacute;a previamente en persistencia.
     *
     * @param enlaceTransaccional enlace para hacer at&oacute;micas las transacciones.
     * @param o                   Usuario
     *
     * @return Usuario despu&eacute;s de persistirse.
     *
     * @throws AlreadyPersistedObjectException
     *          en caso de que este {@link Usuario} ya existiera en persistencia.
     */
    Usuario saveUsuario(Usuario o, final EnlaceTransaccional enlaceTransaccional) throws AlreadyPersistedObjectException, DAOException;


    /**
     * Actualiza un {@link Usuario} en persistencia
     *
     * @param enlaceTransaccional enlace para hacer at&oacute;micas las transacciones.
     * @param o                   a actualizar
     *
     * @return {@link Usuario} actualizado
     *
     * @throws NotAPersistedObjectException en caso de que este {@link Usuario} no existiera en persistencia.
     */
    Usuario updateUsuario(Usuario o, final EnlaceTransaccional enlaceTransaccional) throws NotAPersistedObjectException, DAOException;

    /**
     * Devuelve un {@link Usuario} a partir de su id.
     *
     * @param enlaceTransaccional enlace para hacer at&oacute;micas las transacciones.
     * @param id                  del {@link Usuario} que se busca
     *
     * @return {@link Usuario} en caso de encontrarlo, <code>null</code> en otro caso.
     *
     * @throws DAOException si se presenta alg&uacute;n problema.
     */
    Usuario findUsuarioPorId(Long id, final EnlaceTransaccional enlaceTransaccional) throws DAOException;


    /**
     * Elimina un {@link Usuario} del sistema de persistencia.
     *
     * @param enlaceTransaccional enlace para hacer at&oacute;micas las transacciones.
     * @param o                   que se pretende elimninar.
     *
     * @throws NotAPersistedObjectException si dicho objeto no exist&iacute;a en persistencia.
     */
    void deleteUsuario(Usuario o, final EnlaceTransaccional enlaceTransaccional) throws NotAPersistedObjectException, DAOException;

    /**
     * Elimina los {@link Usuario} identificados con la identificaci&oacute;n.
     *
     * @param identificacion      cuyos {@link Usuario}s se van a eliminar.
     * @param enlaceTransaccional enlace para hacer at&oacute;micas las transacciones.
     *
     * @return n&uacute;mero de {@link Usuario}s eliminados.
     *
     * @throws DAOException si se presenta alg&uacute;n problema.
     */
    int deleteUsuariosPorIdentificacion(final String identificacion, final EnlaceTransaccional enlaceTransaccional) throws DAOException;

    /**
     * Devuelve un listado de los {@link Usuario} que se encuentran en persistencia.
     *
     * @param enlaceTransaccional enlace para hacer at&oacute;micas las transacciones.
     *
     * @return List de objetos {@link Usuario}, sin objetos en caso de no haberlos.
     *
     * @throws DAOException si se presenta alg&uacute;n problema.
     */
    List<Usuario> listUsuario(EnlaceTransaccional enlaceTransaccional) throws DAOException;

    /**
     * Determina si ya se encuentra reservado un nombre de Usuario.
     *
     * @param identificacion      del {@link Identificacion} que se busca
     * @param dominio
     * @param enlaceTransaccional enlace para hacer at&oacute;micas las transacciones. @return <code>true</code> si el userName ya existe; <code>false</code> en caso contrario.
     *
     * @throws com.psiqueware.alheli.dao.DAOException
     *          si se presenta alg&uacute;n problema.
     */
    boolean isIdentificacionReservada(String identificacion, final Dominio dominio, final EnlaceTransaccional enlaceTransaccional) throws DAOException;

    /**
     * Devuelve un {@link Usuario} a partir de su identificacion.
     * No deberia importar si es mayusculas o minusculas.
     *
     * @param identificacion      del {@link Usuario}.
     * @param enlaceTransaccional enlace para hacer at&oacute;micas las transacciones.
     *
     * @return {@link Usuario} en caso de encontrarse; <code>null</code> en caso contrario.
     *
     * @throws com.psiqueware.alheli.dao.DAOException
     *          si se presenta alg&uacute;n problema.
     */
    Usuario findUsuarioPorIdentificacion(final String identificacion, final EnlaceTransaccional enlaceTransaccional) throws DAOException;

    /**
     * Devuelve un listado de los {@link Usuario} para dominio dado que se encuentran en persistencia.
     *
     * @param enlaceTransaccional enlace para hacer at&oacute;micas las transacciones.
     *
     * @return List de objetos {@link Usuario}, sin objetos en caso de no haberlos.
     *
     * @throws DAOException si se presenta alg&uacute;n problema.
     */
    List<Usuario> listUsuario(final Dominio dominio, final EnlaceTransaccional enlaceTransaccional) throws DAOException;

    /**
     * Elimina los {@link Usuario}s identificados con la identificaci&oacute;n y el {@link Dominio}.
     *
     * @param identificacion      cuyos {@link Usuario}s se van a eliminar.
     * @param dominio             para el cual se elimina.
     * @param enlaceTransaccional enlace para hacer at&oacute;micas las transacciones.
     *
     * @return n&uacute;mero de {@link Usuario}s eliminados.
     *
     * @throws DAOException si se presenta alg&uacute;n problema.
     */
    int deleteUsuariosPorIdentificacionIdDominio(final String identificacion, final Dominio dominio, final EnlaceTransaccional enlaceTransaccional) throws DAOException;

    /**
     * Devuelve un {@link Usuario} a partir de su identificacion.
     * No deberia importar si es mayusculas o minusculas.
     *
     * @param identificacion      del {@link Usuario}.
     * @param dominio             de la identificacion.
     * @param enlaceTransaccional enlace para hacer at&oacute;micas las transacciones.
     *
     * @return {@link Usuario} en caso de encontrarse; <code>null</code> en caso contrario.
     *
     * @throws com.psiqueware.alheli.dao.DAOException
     *          si se presenta alg&uacute;n problema.
     */
    Usuario findUsuarioPorIdentificacionDominio(final String identificacion, final Dominio dominio, final EnlaceTransaccional enlaceTransaccional) throws DAOException;
}
